gridpack::mapper::FullMatrixMap< _network > Class Template Reference

#include <full_map.hpp>

Collaboration diagram for gridpack::mapper::FullMatrixMap< _network >:

[legend]

List of all members.

Public Member Functions
	FullMatrixMap (boost::shared_ptr< _network > network)
	~FullMatrixMap ()
boost::shared_ptr < gridpack::math::Matrix >	mapToMatrix (bool isDense=false)
boost::shared_ptr < gridpack::math::RealMatrix >	mapToRealMatrix (bool isDense=false)
gridpack::math::Matrix *	intMapToMatrix (bool isDense=false)
void	mapToMatrix (gridpack::math::Matrix &matrix)
void	mapToRealMatrix (gridpack::math::RealMatrix &matrix)
void	mapToMatrix (boost::shared_ptr< gridpack::math::Matrix > &matrix)
void	mapToRealMatrix (boost::shared_ptr< gridpack::math::RealMatrix > &matrix)
void	overwriteMatrix (gridpack::math::Matrix &matrix)
void	overwriteMatrix (boost::shared_ptr< gridpack::math::Matrix > &matrix)
void	incrementMatrix (gridpack::math::Matrix &matrix)
void	incrementMatrix (boost::shared_ptr< gridpack::math::Matrix > &matrix)
bool	check (void)

template<class _network>
class gridpack::mapper::FullMatrixMap< _network >

---

Constructor & Destructor Documentation

template<class _network>

gridpack::mapper::FullMatrixMap< _network >::FullMatrixMap

(

boost::shared_ptr< _network >

network

)

Initialize mapper for the given network and the current mode. Create global arrays that contain offsets that will be used to create matrix from the network component objects

Parameters:

network

network that will generate matrix

template<class _network>

gridpack::mapper::FullMatrixMap< _network >::~FullMatrixMap

(

)

---

Member Function Documentation

template<class _network>

bool gridpack::mapper::FullMatrixMap< _network >::check

(

void

)

Check to see if matrix looks well formed. This method runs through all branches and verifies that the dimensions of the branch contributions match the dimensions of the bus contributions at each end. If there is a discrepancy, then an error message is generated.

References gridpack::component::BaseBusComponent::getOriginalIndex(), and gridpack::component::MatVecInterface::matrixDiagSize().

template<class _network>

void gridpack::mapper::FullMatrixMap< _network >::incrementMatrix

(

boost::shared_ptr< gridpack::math::Matrix > &

matrix

)

Increment elements of existing matrix. This can be used to increment selected elements of a matrix

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::mapper::FullMatrixMap< _network >::incrementMatrix().

template<class _network>

void gridpack::mapper::FullMatrixMap< _network >::incrementMatrix

(

gridpack::math::Matrix &

matrix

)

Increment elements of existing matrix. This can be used to increment selected elements of a matrix

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::math::BaseMatrixInterface< T, I >::ready().

template<class _network>

gridpack::math::Matrix* gridpack::mapper::FullMatrixMap< _network >::intMapToMatrix

(

bool

isDense = false

)

Generate matrix from current component state on network and return a conventional pointer to it. Used for Fortran interface

Parameters:

isDense

set to true if creating a dense matrix

Returns:

return a pointer to new matrix

References gridpack::utility::CoarseTimer::createCategory(), gridpack::math::Dense, gridpack::math::BaseMatrixInterface< T, I >::ready(), gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

template<class _network>

void gridpack::mapper::FullMatrixMap< _network >::mapToMatrix

(

boost::shared_ptr< gridpack::math::Matrix > &

matrix

)

Reset existing matrix from current component state on network

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::mapper::FullMatrixMap< _network >::mapToMatrix().

template<class _network>

void gridpack::mapper::FullMatrixMap< _network >::mapToMatrix

(

gridpack::math::Matrix &

matrix

)

Reset existing matrix from current component state on network

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::utility::CoarseTimer::createCategory(), gridpack::math::BaseMatrixInterface< T, I >::ready(), gridpack::utility::CoarseTimer::start(), gridpack::utility::CoarseTimer::stop(), and gridpack::math::BaseMatrixInterface< T, I >::zero().

template<class _network>

boost::shared_ptr<gridpack::math::Matrix> gridpack::mapper::FullMatrixMap< _network >::mapToMatrix

(

bool

isDense = false

)

Generate matrix from current component state on network

Parameters:

isDense

set to true if creating a dense matrix

Returns:

return a pointer to new matrix

References gridpack::utility::CoarseTimer::createCategory(), gridpack::math::Dense, gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

template<class _network>

void gridpack::mapper::FullMatrixMap< _network >::mapToRealMatrix

(

boost::shared_ptr< gridpack::math::RealMatrix > &

matrix

)

Reset existing matrix from current component state on network

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::mapper::FullMatrixMap< _network >::mapToRealMatrix().

template<class _network>

void gridpack::mapper::FullMatrixMap< _network >::mapToRealMatrix

(

gridpack::math::RealMatrix &

matrix

)

Reset existing matrix from current component state on network

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::utility::CoarseTimer::createCategory(), gridpack::math::BaseMatrixInterface< T, I >::ready(), gridpack::utility::CoarseTimer::start(), gridpack::utility::CoarseTimer::stop(), and gridpack::math::BaseMatrixInterface< T, I >::zero().

template<class _network>

boost::shared_ptr<gridpack::math::RealMatrix> gridpack::mapper::FullMatrixMap< _network >::mapToRealMatrix

(

bool

isDense = false

)

Generate real matrix from current component state on network

Parameters:

isDense

set to true if creating a dense matrix

Returns:

return a pointer to new matrix

References gridpack::utility::CoarseTimer::createCategory(), gridpack::math::Dense, gridpack::utility::CoarseTimer::start(), and gridpack::utility::CoarseTimer::stop().

template<class _network>

void gridpack::mapper::FullMatrixMap< _network >::overwriteMatrix

(

boost::shared_ptr< gridpack::math::Matrix > &

matrix

)

Overwrite elements of existing matrix. This can be used to overwrite selected elements of a matrix

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::mapper::FullMatrixMap< _network >::overwriteMatrix().

template<class _network>

void gridpack::mapper::FullMatrixMap< _network >::overwriteMatrix

(

gridpack::math::Matrix &

matrix

)

Overwrite elements of existing matrix. This can be used to overwrite selected elements of a matrix

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::math::BaseMatrixInterface< T, I >::ready().

---

The documentation for this class was generated from the following file:

• full_map.hpp